Odbc driver feature by Ylonies · Pull Request #596 · ydb-platform/ydb-cpp-sdk

Ylonies · 2026-04-08T12:58:06Z

No description provided.

Copilot

Pull request overview

Adds an initial YDB ODBC driver implementation (handles, connections, statements, attribute handling, basic metadata queries, and ODBC escape rewriting) along with unit/integration tests and CMake build integration so the driver can be built as part of the SDK.

Changes:

Introduces ydb-odbc shared library with core ODBC entrypoints and supporting utilities (conversion, diagnostics, cursors, attribute parsing, escape rewriting).
Adds ODBC unit tests (escape rewriting, SQL LIKE matching, param conversion) and integration tests (basic query flow, env/conn/stmt attrs).
Integrates ODBC build/test targets into the SDK CMake configuration (option, preset, external ODBC dependency, test helper).

Reviewed changes

Copilot reviewed 54 out of 54 changed files in this pull request and generated 19 comments.

Show a summary per file

File	Description
tests/unit/library/operation_id/CMakeLists.txt	Adds proto library dependency to operation_id unit test.
odbc/tests/unit/sql_like_ut.cpp	Unit tests for SQL LIKE pattern matching helper.
odbc/tests/unit/escape_ut.cpp	Unit tests for ODBC escape sequence rewriting.
odbc/tests/unit/convert_ut.cpp	Unit tests for ODBC parameter conversion to YDB params.
odbc/tests/unit/CMakeLists.txt	Defines ODBC unit test targets and include paths.
odbc/tests/integration/test_utils.h	Common ODBC integration test helpers (connect, error formatting).
odbc/tests/integration/stmt_attr_it.cpp	Integration tests for statement attributes + metadata-id behavior.
odbc/tests/integration/env_it.cpp	Integration tests for environment-level transactions (SQLEndTran).
odbc/tests/integration/CMakeLists.txt	Defines ODBC integration test targets.
odbc/tests/integration/basic_it.cpp	Integration tests for simple query, parameters, and column binding.
odbc/tests/integration/attr_it.cpp	Integration tests for env/connection attribute behavior.
odbc/tests/CMakeLists.txt	Adds ODBC tests subdirectories.
odbc/src/utils/util.h	Declares helper for converting ODBC strings to std::string.
odbc/src/utils/util.cpp	Implements ODBC string conversion helper.
odbc/src/utils/types.h	Declares YDB-type to ODBC-metadata helpers.
odbc/src/utils/types.cpp	Implements (partially) YDB-type to ODBC-metadata helpers.
odbc/src/utils/sql_like.h	Adds inline SQL LIKE matcher used by metadata filtering.
odbc/src/utils/escape.h	Declares ODBC escape rewrite function.
odbc/src/utils/escape.cpp	Implements ODBC escape rewriting (+ CONVERT-to-CAST rewriting).
odbc/src/utils/error_manager.h	Adds diagnostic record storage + exception-to-diagnostic helpers.
odbc/src/utils/error_manager.cpp	Implements diagnostic record mapping and retrieval.
odbc/src/utils/diag.h	Provides small helpers for standard SQLSTATE diagnostics.
odbc/src/utils/cursor.h	Declares cursor abstraction for exec/virtual cursors.
odbc/src/utils/cursor.cpp	Implements exec cursor (stream iterator) and virtual cursor (in-memory table).
odbc/src/utils/convert.h	Declares parameter and column conversion helpers.
odbc/src/utils/convert.cpp	Implements ODBC param conversion registry + YDB->ODBC column conversion.
odbc/src/utils/bindings.h	Defines bound parameter/column structs and binding filler interface.
odbc/src/utils/attr.h	Declares attribute read/write helpers (string + integer tokens).
odbc/src/utils/attr.cpp	Implements attribute string read/write and truncation diagnostics.
odbc/src/statement.h	Declares statement handle (prepare/execute/fetch/metadata/attrs).
odbc/src/statement.cpp	Implements statement execution, binding, metadata queries, and pattern scanning.
odbc/src/statement_attr.h	Declares statement attribute storage + get/set API.
odbc/src/statement_attr.cpp	Implements statement attribute get/set logic.
odbc/src/odbc_driver.cpp	Implements ODBC C entrypoints wiring to internal handle objects.
odbc/src/environment.h	Declares environment handle (attrs, connection registry, EndTran).
odbc/src/environment.cpp	Implements environment attrs and env-level EndTran across connections.
odbc/src/connection.h	Declares connection handle (connect/attrs/tx/session/client mgmt).
odbc/src/connection.cpp	Implements connection string parsing, driver pooling, tx control, catalog routing.
odbc/src/connection_attr.h	Declares connection attribute storage + catalog routing helpers.
odbc/src/connection_attr.cpp	Implements connection attributes (autocommit, access mode, isolation, catalog).
odbc/README.md	Adds build/config/usage documentation for the ODBC driver.
odbc/odbcinst.ini	Provides installed driver registration template.
odbc/odbc.ini	Provides sample DSN configuration template.
odbc/examples/scheme/main.cpp	Example program using SQLTables to enumerate tables.
odbc/examples/scheme/CMakeLists.txt	Builds scheme example and injects built driver path macro.
odbc/examples/CMakeLists.txt	Adds example subdirectories.
odbc/examples/basic/main.cpp	Example program using params and result fetching/binding.
odbc/examples/basic/CMakeLists.txt	Builds basic example and injects built driver path macro.
odbc/CMakeLists.txt	Builds/install `ydb-odbc` and adds tests/examples subdirs.
CMakePresets.json	Enables YDB_SDK_ODBC in presets.
CMakeLists.txt	Adds YDB_SDK_ODBC option and includes `odbc/` when enabled.
cmake/testing.cmake	Adds `add_odbc_test()` helper when ODBC is enabled.
cmake/external_libs.cmake	Adds `find_package(ODBC REQUIRED)` under YDB_SDK_ODBC.
cmake/common.cmake	Extends `_ydb_sdk_add_library` options and changes global lib creation helper.

Comments suppressed due to low confidence (1)

cmake/common.cmake:126

add_global_library_for() now calls _ydb_sdk_add_library(${TgtName} STATIC ...), but _ydb_sdk_add_library() does not recognize a STATIC option. As a result, the created library type depends on CMake defaults/BUILD_SHARED_LIBS instead of being explicitly STATIC, which can break link behavior (whole-archive) and packaging. Please either teach _ydb_sdk_add_library() to accept STATIC, or change add_global_library_for() to call add_library(${TgtName} STATIC) (or _ydb_sdk_add_library with an explicit mode it supports).

function(add_global_library_for TgtName MainName)
  _ydb_sdk_add_library(${TgtName} STATIC ${ARGN})
  if(APPLE)
    target_link_options(${MainName} INTERFACE "SHELL:-Wl,-force_load,$<TARGET_FILE:$<INSTALL_INTERFACE:YDB-CPP-SDK::>${TgtName}>")
  else()
    target_link_options(${MainName} INTERFACE "SHELL:-Wl,--whole-archive $<TARGET_FILE:$<INSTALL_INTERFACE:YDB-CPP-SDK::>${TgtName}> -Wl,--no-whole-archive")
  endif()
  add_dependencies(${MainName} ${TgtName})
  target_link_libraries(${MainName} INTERFACE ${TgtName})
endfunction()

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 63 out of 63 changed files in this pull request and generated 16 comments.

Comments suppressed due to low confidence (1)

cmake/common.cmake:123

add_global_library_for() now calls _ydb_sdk_add_library(${TgtName} STATIC ${ARGN}), but _ydb_sdk_add_library() doesn’t handle the STATIC keyword or forward ${ARGN} as sources. This effectively creates an (empty) library target and drops the intended source list, which will break builds if/when add_global_library_for is used. Consider either restoring add_library(${TgtName} STATIC ${ARGN}) here, or extending _ydb_sdk_add_library to accept a library type + source list (or call target_sources() with the unparsed args).

function(add_global_library_for TgtName MainName)
  _ydb_sdk_add_library(${TgtName} STATIC ${ARGN})
  if(APPLE)
    target_link_options(${MainName} INTERFACE "SHELL:-Wl,-force_load,$<TARGET_FILE:$<INSTALL_INTERFACE:YDB-CPP-SDK::>${TgtName}>")
  else()
    target_link_options(${MainName} INTERFACE "SHELL:-Wl,--whole-archive $<TARGET_FILE:$<INSTALL_INTERFACE:YDB-CPP-SDK::>${TgtName}> -Wl,--no-whole-archive")
  endif()

EndTran for env + tests

Combine connection attribute routing and error-localization updates into one focused commit while keeping driver pool changes separate. Made-with: Cursor

Gazizonoki · 2026-05-19T23:23:49Z

+            std::optional<NQuery::TExecuteQueryPart> prefetchedPart)
+        : BindingFiller_(bindingFiller)
+        , Iterator_(std::move(iterator))
+        , PrefetchedPart_(std::move(prefetchedPart))


А не проще вызвать 1 раз Fetch, а не передавать PrefetchedPart_

Нет, fetch() не только читает стрим, но и переходит на первую строку (TryNextRow). Если вызвать его в конце Execute, приложение на первом SQLFetch получит вторую строку.

Я не буквально имею в виду. Тут вот какие замечания:

prefetched part частично дублирует логику fetch

Мы размазываем зону логику вычитывания результата на вызывающую сторону

Gazizonoki · 2026-05-19T23:56:34Z

+add_ydb_test(NAME odbc-escape_ut GTEST
+  SOURCES
+    escape_ut.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/../../src/utils/escape.cpp


А мы не можем просто позависить на ydb-odbc?

?? по-моему сейчас ок

Gazizonoki · 2026-05-22T14:16:24Z

@@ -277,31 +277,21 @@
    std::optional<std::string> fetched;
    const NYdb::TStatus status = client->RetryQuerySync(


Можем поставить флаг идемпотентности, так ретраить лучше будет

Gazizonoki · 2026-05-22T14:17:24Z

            return NYdb::TStatus(EStatus::SUCCESS, NYdb::NIssue::TIssues());
        });

    if (status.IsSuccess() && fetched && !fetched->empty()) {


Может тут лучше ошибку выдавать, если получить не смогли версию?

Gazizonoki · 2026-05-22T14:18:36Z

 add_subdirectory(examples)
 add_subdirectory(tests)
-
-install(FILES


А не для тестов генерить не надо?

Gazizonoki · 2026-05-22T14:26:40Z

+
+For `SQLConnect("YDB", ...)`, `isql -v YDB`, or `Driver=YDB`.
+
+**`odbcinst.ini`** — driver registration. Section `[YDB]` is the driver name used as `Driver=YDB` in connection strings and DSNs. `Driver` and `Setup` are the full path to `libydb-odbc.so`. Use `/etc/odbcinst.ini`, a file in `/etc/odbcinst.d/`, or set `ODBCSYSINI` to the directory that contains `odbcinst.ini`.


В моем понимании odbcinst.ini - генерится, odbc.ini - пишет пользователь

Gazizonoki requested changes Apr 24, 2026

View reviewed changes

Comment thread odbc/src/utils/bindings.h Outdated

Comment thread odbc/src/odbc_driver.cpp

Comment thread odbc/src/statement.cpp

Comment thread odbc/src/statement.cpp Outdated

Comment thread odbc/src/connection_attributes.cpp Outdated

Gazizonoki requested a review from Copilot May 4, 2026 18:07

Copilot started reviewing on behalf of Gazizonoki May 4, 2026 18:08 View session

Gazizonoki added the need_ai_review label May 4, 2026

robot-vibe-db Bot added ai_review_in_process and removed need_ai_review labels May 4, 2026

Copilot AI reviewed May 4, 2026

View reviewed changes

Gazizonoki requested a review from Copilot May 12, 2026 14:39

Copilot started reviewing on behalf of Gazizonoki May 12, 2026 14:40 View session

Copilot AI reviewed May 12, 2026

View reviewed changes

Gazizonoki and others added 20 commits May 12, 2026 20:40

started work

56e6d5f

C API

708095f

ODBC MVP

919ac81

Revert C API

a04c93e

Parameter bind

51aa98b

Add unit test

3c84ed7

fix

f6c07af

added tx support

cc4a1ba

step

6abcddc

step

6797730

step

6ccf021

Error handlig

e01e5b8

some fixes

700a41f

env features

6636966

EndTran for env + tests

attributes

4e49c2f

fix

a0a8ac6

driver pool

aa89fe3

conn attributes

5c4f661

Combine connection attribute routing and error-localization updates into one focused commit while keeping driver pool changes separate. Made-with: Cursor

stmt attr

db6b16d

retry qyery for autocommit

35afe1c

Ylonies added 6 commits May 12, 2026 20:42

getdiagfield + fixes

fc1e585

review fixes

33114de

full core api tests

f094c73

some metadata functions

5ab58b2

erlang odbc client

9609747

fixes

835c5d1

Ylonies force-pushed the odbc-driver-feature branch from 90c479b to 835c5d1 Compare May 12, 2026 17:48

fix odbc covert for chrono

bec77d6

Gazizonoki reviewed May 17, 2026

View reviewed changes

fix

69f3a70

Gazizonoki reviewed May 20, 2026

View reviewed changes

review fixes

3035d7f

Gazizonoki reviewed May 22, 2026

View reviewed changes

		@@ -277,31 +277,21 @@
		std::optional<std::string> fetched;
		const NYdb::TStatus status = client->RetryQuerySync(


		For `SQLConnect("YDB", ...)`, `isql -v YDB`, or `Driver=YDB`.

		`odbcinst.ini` — driver registration. Section `[YDB]` is the driver name used as `Driver=YDB` in connection strings and DSNs. `Driver` and `Setup` are the full path to `libydb-odbc.so`. Use `/etc/odbcinst.ini`, a file in `/etc/odbcinst.d/`, or set `ODBCSYSINI` to the directory that contains `odbcinst.ini`.

Conversation

Ylonies commented Apr 8, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants